-
-
Notifications
You must be signed in to change notification settings - Fork 160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc: update installation of NodeJS, add paths for NMEA sample files + cosmetics #1648
Conversation
Good to know that node installation scripts are nowadays deprecated, this has impact to docker images too. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why add the commands to find the paths of the sample files? Why would an end user need to find the paths? There are no instructions what the end user should do with the paths.
Did a fresh install of the SK server and used the new documentation to check. What I missed at the end, after running the setup script and adding the admin account, was information about how to use the sample files. It's very nice to use the sample files to be acquainted with the functions of SK. So below the heading "Set up data connections" I thought that the info for the paths was appropriate. The paths to the files have changed during different versions of the SK server so instead of a fixed path to the file I used the command to find the file. |
How to run the server with sample data is documented in
How do you expect the end user to use the sample file paths? Once you yourself found them how did you use them? |
Absolutely it's documented how to use it from command line. The first 2 ways will threw some confusing errors IF you have run the setup script since one instance of the SK server is already running... Of course you could stop the running SK server but will a newbie understand that ? The 3:d way is as said command line. The above could be a little confusing for a newbie which I think is addressed in these pages of documentation. When I'm testing things, NodeRed, new plugins and so on, I'm using sample files on a test server at home. Most often I'm using own recorded files but sometimes the mentioned sample files delivered with SK. I thought this use case could be appropriate for other users starting up/using SK. It was also mentioned in the old documentation. But as usual, no big deal just trying to help. |
I really appreciate your contributions! Don’t get me weong. I just don’t see how an end user would benefit from knowing the path to the sample files, with no additional instructions what to do with the path. |
Ok, you got a point ..... Will do an update later on. |
I'd like to get this updated & merged, please. |
Added information on how to use sample files
Settings for a NMEA 2000 file as input
Settings for a NMEA 2000 file as input
Installed in wrong directory ...
My sincere apologies for the delay ! |
Thanks! Now the docs document the use of FileStream connection type, that people regularly ask about. |
No description provided.